<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="documentai_v1.html">Cloud Document AI API</a> . <a href="documentai_v1.projects.html">projects</a> . <a href="documentai_v1.projects.locations.html">locations</a> . <a href="documentai_v1.projects.locations.processorTypes.html">processorTypes</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a processor type detail.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the processor types that exist.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets a processor type detail.

Args:
  name: string, Required. The processor type resource name. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A processor type is responsible for performing a certain document understanding task on a certain type of document.
  &quot;allowCreation&quot;: True or False, # Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access.
  &quot;availableLocations&quot;: [ # The locations in which this processor is available.
    { # The location information about where the processor is available.
      &quot;locationId&quot;: &quot;A String&quot;, # The location ID. For supported locations, refer to [regional and multi-regional support](/document-ai/docs/regions).
    },
  ],
  &quot;category&quot;: &quot;A String&quot;, # The processor category, used by UI to group processor types.
  &quot;launchStage&quot;: &quot;A String&quot;, # Launch stage of the processor type
  &quot;name&quot;: &quot;A String&quot;, # The resource name of the processor type. Format: `projects/{project}/processorTypes/{processor_type}`
  &quot;sampleDocumentUris&quot;: [ # A set of Cloud Storage URIs of sample documents for this processor.
    &quot;A String&quot;,
  ],
  &quot;type&quot;: &quot;A String&quot;, # The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists the processor types that exist.

Args:
  parent: string, Required. The location of processor types to list. Format: `projects/{project}/locations/{location}`. (required)
  pageSize: integer, The maximum number of processor types to return. If unspecified, at most `100` processor types will be returned. The maximum value is `500`. Values above `500` will be coerced to `500`.
  pageToken: string, Used to retrieve the next page of results, empty if at the end of the list.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for the ListProcessorTypes method.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Points to the next page, otherwise empty.
  &quot;processorTypes&quot;: [ # The processor types.
    { # A processor type is responsible for performing a certain document understanding task on a certain type of document.
      &quot;allowCreation&quot;: True or False, # Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access.
      &quot;availableLocations&quot;: [ # The locations in which this processor is available.
        { # The location information about where the processor is available.
          &quot;locationId&quot;: &quot;A String&quot;, # The location ID. For supported locations, refer to [regional and multi-regional support](/document-ai/docs/regions).
        },
      ],
      &quot;category&quot;: &quot;A String&quot;, # The processor category, used by UI to group processor types.
      &quot;launchStage&quot;: &quot;A String&quot;, # Launch stage of the processor type
      &quot;name&quot;: &quot;A String&quot;, # The resource name of the processor type. Format: `projects/{project}/processorTypes/{processor_type}`
      &quot;sampleDocumentUris&quot;: [ # A set of Cloud Storage URIs of sample documents for this processor.
        &quot;A String&quot;,
      ],
      &quot;type&quot;: &quot;A String&quot;, # The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

</body></html>